User Input Fields

User input fields are editable fields within a generated message that can be updated prior to a message being sent. The text edits are made within the Messaging UI removing the requirement to download, edit, and re-upload an amended message.

These fields can be used either as named input fields or in combination with message substitution codes allowing default values to be edited when necessary.

Due to audit risk, some transactional substitution codes cannot be used. This functionality is best suited for Invoice Messages, Credit Notes, and Receipts as it allows the editing of message contents while ensuring that auditable transaction data remains unchanged.

 

NOTE: Booking Agent Messages, Booking Supplier Messages, Voucher Messages, Invoice Messages, Credit Notes and Receipts can be configured to use User Input Fields. The message template will need to be set to External editing in Code Setup

User Input field editing does not update data within a booking - the edited text will only display on the generated message.

Configuring User Input Fields

Editable fields can be configured within a message template by using the following field codes.

Entering text in place of the example 'Label Text' will create a Labelled Field Name in the User Input list.

Field Code Field Type
[UID:Label Text] User input date or selection field described by the label text.
[UIS:Label Text] User input string field described by the label text (max length 120 characters).
[UIT:Label Text] User input text field described by described by the label text.
[UIN:Label Text] User input numeric field described by described by the label text.
[UIV:Label Text] User input data value field described by described by the label text and with 2 decimal places.

User Input Field Code Example

This example displays a message generated with User Input fields. When the message is generated a User Input window appears with a numbered list of fields to enter data.

User Input with Substitution Codes

Using field codes and message substitution codes together defaults a value which the user can change.

Field Code Field Type
[UIx:Label Text:<SubCode>] User Input field described by the 'Label Text' with a default value based on a Substitution Code.

NOTE: The following transaction substitution codes can not be used in combination with User Input field codes as this would present an audit risk:

  • TRNEXT

  • TRNPRICE

  • TRNTOT

  • TRNCOMM

  • TRNTOTCOMM

  • TRNCURR

  • TRNEXCLTAX

  • TRNTOTEXCLTAX

  • TRNDRAMT

  • TRNCRAMT

  • TRNSUB

  • TRNTAX

  • TRNTOTTAX

  • TRNTOC

  • TRNTOTTOC